Skip to main content

FlowDocumentState Methods

An object defining methods for the FlowDocumentState class.

Initialize()

Sets up initial configurations for the flow document state.

Returns:

Type: void
Method does not return anything

This is a sync method. Method runs synchronously.


UpdateStates()

Asynchronously updates the states of all documents within the flow.

Returns:

Type: Task
Task without value

This is a async method. Method should be waited. Be careful if call this method without waiting.

See Also


UpdateState(flowDocument, state)

Asynchronously updates the state of a single flow document.

Parameters:

flowDocument (required): FlowDocument
The document whose state will be updated.

state (required): int
The target state value for the document.

Returns:

Type: Task<bool>
Returns a task that represents the asynchronous operation. The task result is a boolean value indicating whether the state was updated successfully.

This is a async method. Method should be waited. Be careful if call this method without waiting.

See Also